Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add CLI link to readme #86

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add CLI link to readme #86

wants to merge 1 commit into from

Conversation

yancyribbens
Copy link

@yancyribbens yancyribbens commented May 7, 2024 •
edited by coderabbitai bot
Loading

Here's a simple CLI. What about adding some example usage programs like this to the README?

Summary by CodeRabbit

  • Documentation
    • Added an example usage link for esplora-cli in the README file.

@coderabbitai coderabbitai
Copy link

coderabbitai bot commented May 7, 2024 •
edited
Loading

Walkthrough

The update to the repository primarily involves enhancing the README.md document by adding a link to an example usage of the esplora-cli. This modification aims to improve user accessibility and understanding of the tool. There are no changes to the declarations of exported or public entities in this update.

Changes

File Change Summary
README.md Added a link to esplora-cli example usage.
Recent Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between d6bff85 and 5887dff.
Files selected for processing (1)
  • README.md (1 hunks)
Additional Context Used
LanguageTool (1)
README.md (1)

Near line 15: After the expression ‘for example’ a comma is usually used.
Context: ...5005608961?logo=discord">

For example usage, see: - [esplora-cli](https://git...

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

Note: Auto-reply has been disabled for this repository by the repository owner. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

coderabbitai[bot]
coderabbitai bot reviewed May 7, 2024
View reviewed changes
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

Out of diff range and nitpick comments (1)
README.md (1)

15-15: Consider adding a comma after "For example usage".

This would improve the readability of the introduction to the example links.

README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
@oleonardolima
Copy link
Collaborator

Sorry for taking so long, thanks for the suggestion. I think it can be a great addition alongside some other usage examples, and probably the Used by section on the repository too.

We can probably add at least usage examples to the README.md, as we have them on the docs level.

@yancyribbens
Copy link
Author

Sure, I'm open to any/all of these suggestions. Let me know if you want me to edit this PR in some way.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@yancyribbens @oleonardolima